Package | hl7.fhir.us.davinci-ra |
Type | OperationDefinition |
Id | Id |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/davinci-ra/https://build.fhir.org/ig/HL7/davinci-ra/OperationDefinition-ra.evaluate-measure.html |
Url | http://hl7.org/fhir/us/davinci-ra/OperationDefinition/ra.evaluate-measure |
Version | 2.0.0 |
Status | draft |
Date | 2024-12-10T22:27:38+00:00 |
Name | RAEvaluateMeasure |
Title | Evaluate Measure |
Experimental | False |
Realm | us |
Authority | hl7 |
Description | The ra.evaluate-measure operation is used to evaluate Digital Condition Category and obtain the results. |
Type | true |
Kind | operation |
CapabilityStatement | |
ra-reporting-server | Risk Adjustment Reporting Server Capability Statement |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition ra.evaluate-measure
URL: [base]/Measure/$ra.evaluate-measure
URL: [base]/Measure/[id]/$ra.evaluate-measure
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | periodStart | 1..1 | date | The start of a clinical evaluation period. The periodStart and periodEnd parameters will be compared with the clinical evaluation period ( | ||
IN | periodEnd | 1..1 | date | The end of a clinical evaluation period. | ||
IN | subject | 1..1 | string (reference) | Subject will be a reference to either Patient (US Core Patient) or Group (Patient Group). Must provide either Patient/123 or Group/123, cannot simply provide 123. If only 123 is provided, then the operation would not know if it is a Patient reference or a Group reference. | ||
IN | measureId | 0..* | id | The id of a Measure resource for risk adjustment model, e.g., CMS HCC v24 | ||
IN | measureIdentifier | 0..* | string (token) | The business identifier of a Measure resource for risk adjustment model, e.g., CMS HCC v24. | ||
IN | measureUrl | 0..* | canonical | This the URL of a Measure resource for risk adjustment model, e.g., CMS HCC v24 | ||
OUT | return | 0..1 | Bundle | The $ra.evaluate-measure operation will always return one Parameters whether the subject is a single patient or a group of patients. Risk Adjustment Coding Gap Report Bundle for a patient is in a |
{
"resourceType" : "OperationDefinition",
"id" : "ra.evaluate-measure",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ra.evaluate-measure</b></p><a name=\"ra.evaluate-measure\"> </a><a name=\"hcra.evaluate-measure\"> </a><a name=\"ra.evaluate-measure-en-US\"> </a><p>URL: [base]/Measure/$ra.evaluate-measure</p><p>URL: [base]/Measure/[id]/$ra.evaluate-measure</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>periodStart</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The start of a clinical evaluation period. The periodStart and periodEnd parameters will be compared with the clinical evaluation period (<code>MeasureReport.period.start</code> and <code>MeasureReport.period.end</code>) of a <a href=\"StructureDefinition-ra-measurereport.html\">Risk Adjustment Coding Gap MeasureReport</a> available on the Server. The MeasureReport will be returned if there is an overlap of the two periods.</p>\n</div></td></tr><tr><td>IN</td><td>periodEnd</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The end of a clinical evaluation period.</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Subject will be a reference to either Patient (<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html\">US Core Patient</a>) or Group (<a href=\"StructureDefinition-ra-patient-group.html\">Patient Group</a>). Must provide either Patient/123 or Group/123, cannot simply provide 123. If only 123 is provided, then the operation would not know if it is a Patient reference or a Group reference.</p>\n</div></td></tr><tr><td>IN</td><td>measureId</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#id\">id</a></td><td/><td><div><p>The id of a Measure resource for risk adjustment model, e.g., CMS HCC v24</p>\n</div></td></tr><tr><td>IN</td><td>measureIdentifier</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>The business identifier of a Measure resource for risk adjustment model, e.g., CMS HCC v24.</p>\n</div></td></tr><tr><td>IN</td><td>measureUrl</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>This the URL of a Measure resource for risk adjustment model, e.g., CMS HCC v24</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The $ra.evaluate-measure operation will always return one <a href=\"https://www.hl7.org/fhir/parameters.html\">Parameters</a> whether the subject is a single patient or a group of patients. <a href=\"StructureDefinition-ra-measurereport-bundle.html\">Risk Adjustment Coding Gap Report Bundle</a> for a patient is in a <code>Parameters.parameter</code> element. A Risk Adjustment Coding Gap Report Bundle contains the Risk Adjustment Coding Gap Reports for the same patient. For example, if a Group has 10 valid patients, then a <a href=\"https://www.hl7.org/fhir/parameters.html\">Parameters</a> will contain 10 <code>Parameters.parameter</code>elements, with each <code>Parameters.parameter</code> for a unique patient.</p>\n</div></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cqi"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "draft"
}
],
"url" : "http://hl7.org/fhir/us/davinci-ra/OperationDefinition/ra.evaluate-measure",
"version" : "2.0.0",
"name" : "RAEvaluateMeasure",
"title" : "Evaluate Measure",
"status" : "draft",
"kind" : "operation",
"date" : "2024-12-10T22:27:38+00:00",
"publisher" : "HL7 International / Clinical Quality Information",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cqi"
}
]
}
],
"description" : "The ra.evaluate-measure operation is used to evaluate Digital Condition Category and obtain the results.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"code" : "ra.evaluate-measure",
"base" : "http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure",
"resource" : [
"Measure"
],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [
{
"name" : "periodStart",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The start of a clinical evaluation period. The periodStart and periodEnd parameters will be compared with the clinical evaluation period (`MeasureReport.period.start` and `MeasureReport.period.end`) of a [Risk Adjustment Coding Gap MeasureReport](StructureDefinition-ra-measurereport.html) available on the Server. The MeasureReport will be returned if there is an overlap of the two periods.",
"type" : "date"
},
{
"name" : "periodEnd",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The end of a clinical evaluation period.",
"type" : "date"
},
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Subject will be a reference to either Patient ([US Core Patient](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html)) or Group ([Patient Group](StructureDefinition-ra-patient-group.html)). Must provide either Patient/123 or Group/123, cannot simply provide 123. If only 123 is provided, then the operation would not know if it is a Patient reference or a Group reference.",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "measureId",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The id of a Measure resource for risk adjustment model, e.g., CMS HCC v24",
"type" : "id"
},
{
"name" : "measureIdentifier",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The business identifier of a Measure resource for risk adjustment model, e.g., CMS HCC v24.",
"type" : "string",
"searchType" : "token"
},
{
"name" : "measureUrl",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "This the URL of a Measure resource for risk adjustment model, e.g., CMS HCC v24",
"type" : "canonical"
},
{
"name" : "return",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The $ra.evaluate-measure operation will always return one [Parameters](https://www.hl7.org/fhir/parameters.html) whether the subject is a single patient or a group of patients. [Risk Adjustment Coding Gap Report Bundle](StructureDefinition-ra-measurereport-bundle.html) for a patient is in a `Parameters.parameter` element. A Risk Adjustment Coding Gap Report Bundle contains the Risk Adjustment Coding Gap Reports for the same patient. For example, if a Group has 10 valid patients, then a [Parameters](https://www.hl7.org/fhir/parameters.html) will contain 10 `Parameters.parameter`elements, with each `Parameters.parameter` for a unique patient.",
"type" : "Bundle"
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.